Structure Chart Addendum

Function	Info
AddBookmark	Parameters: BookmarkDataStruct NewBookmark: In - Bookmark data to be added to the structure. BookmarkDataPtr ListHeadPtr: In & Out - a pointer to the first item in the list
AddFolder	Parameters: NewFolder: In & Out – Bookmark data to be added to the structure. Pointers to adjancent list nodes returned ListHead: In & Out - a pointer to the first item in the list.
AddOneBookmarkToCUIList	Parameters: BookmarkDataPtr BookmarkToAdd: In – A pointer to the Bookmark being added CUIListItemPtr &CUIListHeadPtr: In & Out – the CUI List to which the modified Bookmark contents and reference to the origional will be added
AddOneFolderToCUIList	Parameters: FolderDataPtr FolderToAdd: In – A pointer to the folder being added CUIListItemPtr &CUIListHeadPtr: In & Out – the CUI List to which the modified folder contents and reference to the origional will be added
ChangeFilenameExtension	Parameters: char FileName[]: In & Out - A stringcontaining the filename whos extension will be changed. char NewExtension[]: In - A string containing thenew extension for FileName[].
ChangeToFolder	Parameters: int PWF[]: In & Out - An integer array containing the path to the present working folder. NewFolder: In - The folder to add to the path.
ChangeToPreviousFolder	Parameters: Int PWF[]: In & Out - An integer array containing the path to the present working folder.
ChildBookmarksToCUIItemList	Parameters: FolderDataPtr CurrentFolder: In – pointer to the current folder CUIListItemPtr CUIListHead: In & Out – pointer to CUI listhead BookmarkDataPtr BookmarkListHeadPtr: In & Out – pointer to the first item in the bookmarklist
ChildFoldersToCUIItemList	Parameters: FolderDataPtr FolderListHeadPtr: In - pointer to the first item in the folderlist. CUIListItemPtr CUIListHead: In & Out - pointer to CUI listhead. FolderDataPtr CurrentFolder: In - pointer to the current folder.
CreateBookmarkList	Parameters: BookmarkDataPtr ListHeadPtr: In & Out – pointer to the head of the list.
CreateFolderList	Parameters: FolderDataPtr ListHeadPtr: In & Out - Pointer to the head of the list.
CUIAddItem	Parameters: CUIListItemPtr ListHeadPtr: In & out – pointer to the head of the list CUIListItem NewItem: In – the info to be added to the list
CUICreateList	Parameters: CUIListItemPtr ListHeadPtr: Out – pointer to the head of the list
CUICreateWindow	Parameters: int Xpos: In – upper left hand corner of the window int Ypos: In – upper right hand corner of the window int Xsize: In – horizontal size of the window int Ysize: In – Vertical size of the window
CUIDestroyList	Parameters: CUIListItemPtr ListHeadPtr: In & Out – pointer to the head of the list
CUIDestroyWindow	Returns: True if window was removed, false if there was no window to remove
CUIDialogOK	Parameters: const char Text[]: In – the text of the dialog box const char Title[]: In – the title of the dialog box
CUIDialogStringPrompt	Parameters: const char Text[]: In – the text of the dialog box const char Title[]: In – the title of the dialog box char UserResponse[]: Out – The user’s response to the prompt int NumChars: In – the number of chars to retrieve from the user, not incl null terminator.
CUIDisplayFile	Parameters: char FileName[]: In – The filename of the text to display
CUIInit	No Parameters or return value
CUIListCount	Parameters: CUIListItemPtr ListHeadPtr: In – pointer to the head of the circular-linked list being examined Returns; The number of items in the list pointed to by ListHeadPtr
CUIListPrompt	Parameters: CUIListItemPtr ListHead: In – pointer to the listhead of list CUIListItemPtr ItemSelected: Out – a pointer to the item selected by the user char Title[]: In - The text of the window title int LastKey: Out – Last key pressed Note: Position of highlight will be stored on the stack
CUIRedrawScreen	No Parameters or return value
CUIRemoveItem	Parameters: CUIListItemPtr ListHeadPtr: In & Out – pointer to the head of the list CUIListItemPtr ItemToDeletePtr: In – pointer to the item that will be deleted
CUIShutdown	No Parameters or return value. Nuke stack and call Curses shutdown
CUIWriteText	Parameters: int Xpos: In – Upper left corner horizontal string position int Ypos: In – Upper left corner vertial string position const char Text[]: In – Text to place on the background
CurrentFolder	Parameters: int PWF[]: In - An integer array containing the path to the present working folder. Returns: The EntryIndex of the present working folder.
DestroyBookmarkList	Parameters: ListHeadPtr: In & Out - a pointer to the first item in the list.
DestroyFolderList	Parameters: ListHeadPtr: In & Out - a pointer to the first item in the list.
DrawBorder	Parameters: WINDOW *WindoePtr: In – pointer to the window char Title[]: In – the string containing the title to be placed in the border
DrawText	Parameters: WINDOW *WindowPtr: In - pointer to the window char Text[]: In - the string containing the text to be placed in the dialog box
DumpFolder	PARAMETERS: FolderDataPtr FolderListHead: In - pointer to the head of the folder list. BookmarkDataPtr BookmarkListHead: In - pointer to the head of the bookmark list. int FolderEntryIndex: In - the entry index of the folder to dump. int Depth: In - the number of levels to indent the current output ofile OutFile: In & Out - the file to which the bookamark and folder titles will be written.
EditMenu	Parameters: CUIListItemPtr CUICurrentItemPtr: In – Pointer to the currently selected list item
ExportTree	Parameters: FolderDataPtr FolderListHead: In - pointer to the head of the folder list BookmarkDataPtr BookmarkListHead: In - pointer to the head of the bookmark list const char OutputFile[]: In – the filename to which the tree will be dumped.
FileExists	Parameters: char FileName[]: In - An array of chars containing the path/filename of the file to check for.
FileMenu	Parameters: BookmarkDataPtr BookmarkListHeadPtr: In & Out – pointer to the first item in the bookmarklist FolderDataPtr FolderListHeadPtr: In & Out – pointer to the first item in the folderlist FolderDataPtr CurrentFolder: In & Out – pointer to the current folder Bool QuitFlag: Out – True: quit program
FindBookmarkWithName	Parameters: BookmarkDataPtr StartingPointPtr: In – Pointer to the position from which to start searching char Title[]: In – The text to match Returns: A pointer to the first bookmark found with the title matching the firsst strlen(title) chars
FindBookmarkWithParentEntryIndex	Parameters: StartingPosition: Data in – Starting point for search ParentEntryIndexToFind: Data in – the parent entry index to find in the bookmark list. Returns: A pointer to the Bookmark with the ParentEntryIndex mathinging matching ParentEntryIndexToFind
FindFolderWithName	Parameters: FolderDataPtr StartingPointPtr: In – Pointer to the position from which to start searching char Title[]: In – The text to match Returns: A pointer to the first Folder found with the title matching the firsst strlen(title) chars
GetBookmark	Parameters: BookmarkDataStruct NewBM: Out – The contents of the bookmark being read. char Tag[]: In – The bookmark tag ifstream InputFile: In & Out – Inpput filestream from which the tag was read; used to read the name of the bookmark ofstream ErrorLogFile: Data through - Output filestrem to which errors will be sent Returns: True: iff the the function was executed successfully. False: iff the the function was executed and an unrecoverable error was encountered
GetFolder	Parameters: ifstream InputFile: In & Out - Input file stream from which tag will be read. FolderDataStruct NewFLD: Out - The folder information being returned Returns: True: iff the the function was executed successfully. False: iff the the function was executed and an unrecoverable error was encountered.
GetTag	Parameters: ifstream InputFile: In - Input file stream from which to read the chars. Char TagString[]: Out - The text between two <> being returned. Returns: True: iff the the function was executed with no unrecoverable errors. False: iff the the function was executed and an unrecoverable error was encountered.
GetTitle	Parameters: Char TitleString[]: Out - The title string being returned to read the chars. Ifstream InputFile: In & Out - The input filestream from which to read TitleString ofstream ErrorLogFile: Data through - The output filestream where errors go Returns: True: iff the the function was executed with no unrecoverable errors. False: iff the the function was executed and an unrecoverable error was encountered.
GetUTCTime	Parameters: Char PromptText[]: In - Text to show user long DefaultUTCTime: In - The time to use as the default time. Returns: Int: the UTC equivelent of the time entered
ImportBookmarks	Parameters: char InputFileName[]: In - An array that contains the relative filename of the bookmark file to be loaded. BookmarkDataPtr BookmarkListHeadPtr: Out – pointer to the head of the bookmark list FolderDataPtr FolderListHeadPtr: Out – pointer to the head of the folder list char ErrorLogFileName[]: In - An array that contains the relative filename of the erro log to be generated Returns: True: iff the file was loaded with no unrecoverable errors False: iff an unrecoverable error was encountered in the file
InputWALFile	Parameters: BookmarkDataStruct BookmarkListHeadPtr: In & Out - a pointer to the beginning of the bookmark list. FolderDataStruct FolderListHeadPtr: In & Out - a pointer to the beginning of the folder list. char InputFileName[]: In & Out - a string containing the filename from which the WAL file will be loaded Returns: True: iff the file was created with no unrecoverable errors. False: iff an unrecoverable error was encountered.
LenLongestLine	Parameters: char Astring[]: In – string in which to find the longest line Returns: int: The length og the longest line in the string
LoadMenuFromFile	Parameters: CUIListItemPtr MenuList: In & Out –Tthe list to which the menu items will be added const char FileToLoad[]: In – The file to load
main	Parameters: int argc: In – the number of command line arguments char *argv[] – array of strings contianingg the command line params
MakeCUIListFromCurrentFolder	Parameters: FolderDataPtr FolderLIstHeadPtr: In - pointer to the head of the folder list. BookmarkDataPtr BookmarkListHead: In - pointer to the head of the bookmarks list CUIListItemPtr &CUIListHead: In & Out - Pointer to the head of CUI list where the results will be stored. FolderDataPtr CurrentFolder: In & Out - pointer to the current folder
MoveBookmark	Parameters: BookmarkDataPtr BookmarkListPtr: In – pointer to the head of the folder list CUIListItemPtr CUICurrentItemPtr: In – Pointer to the currently selected list item in the main display area
NumericalValueFromTag	Parameters: char Tag[]: In – The tag being seached char Key[]: Control - The key for the value being saught Returns: The numerical value associated with the key
NumLines	Parameters: char Astring[]: In – string in which to find the longest line Returns: int: The number of lines contained in AString
OutputError	Parameters: char Tag[]: In - The tag preceding or in which the error was detected. char ErrorText[]: In - The text of the error infile InputFile: In & Out - Used to grab the rest of the line following the tag. Ofile ErrorLog: Out - The output filestream into which the formatted errors will be inserted.
OutputWALFile	Parameters: BookmarkListHeadPtr: In & Out – a pointer to the beginning of the bookmark list. FolderListHeadPtr: In & Out – a pointer to the beginning of the folder list. OutputFileName[]: In - a string containing the filename of the output file into which the bookmark file structure will be dumped. Returns: True: iff the file was created with no unrecoverable errors. False: iff an unrecoverable error wasencountered.
ParentFolder	Parameters: int PWF[]: In - An integer array containing the path to the present working folder. Returns: The EntryIndex of the present working folder.
ProgramMenu	No Parameters or return value
PromptAddBookmark	Parameters: BookmarkDataPtr BookmarkList: In & Out - pointer to the first item in the bookmark list BookmarkDataStruct: DefaultBookmark: In – provides default and unprompted values
PromptAddFolder	Parameters: FolderDataPtr FolderList: In & Out – pointer to the first item in the Folder list FolderDataStruct: DefaultFolder: In – provides default and unprompted values
RemoveBookmark	Parameters: BookmarkDataPtr ListHeadPtr: In & Out - a pointer the first item in the list. BookmarkDataPtr ThisPtr: In & Out – Pointer to the bookmark to be deleted.
RemoveFolder	Parameters: FolderDataPtr ListHeadPtr: In & Out - a pointer to the first item in the list. FolderDataPtr ThisPtr: In & Out – Pointer to the folder to be deleted. enum DeleteType: In – The type of delete to be performed.
RemoveOneFolder	Parameters: FolderaDataPtr ListHeadPtr: Data in & out – pointer to the first item in the list. FolderDataPtr FolderToDelete: Data in & out - pointer to the item being delete
SearchMenu	Parameters: BookmarkDataPtr BookmarkListPtr: In – pointer to the head of the bookmark list FolderDataPtr FolderListPtr: In – pointer to the head of the CUIListItemPtr CUIListHeadPtr: In – Pointer to the head of the main display area list
ShowBookmark	Parameters: BookmarkDataStruct BookmarkToDisplay: In – the bookmark to display
StackDestroy	No Parameters or return value
StackEmpty	Returns: True - if stack is empty, false iff stackcontains at least 1 item
StackFull	Returns: True -- this stack is never full until the machine runs out of memory.
StackInit	No Parameters or return value
StackPop	Returns: The pointer that was on the top of the stack
StackPush	Parameters: Void *PushThis: In - The pointer info to push onto the stack.
StackTop	Returns: The pointer on the top of the stack without removal
StringValueFromTag	Parameters: Char Tag[]: In – The tag being seached char Key[]: In – The key for the value being saught char ReturnValue[]: Out – The string value associated with the key
WAMMenu	Parameters: BookmarkDataPtr BookmarkListPtr: In – pointer to the head of the bookmark list FolderDataPtr FolderListPtr: In – pointer to the head of the folder list FolderDataPtr CurrentFolder: In – pointer to the current folder CUIListItemPtr CUIListHeadPtr: In – Pointer to the head of the main display area list CUIListItemPtr CUICurrentItemPtr: In – Pointer to the currently selected list item in the main display area
WebAddressManager	Parameters: const char FileToLoad[]: In – a string containing the file to load. If file is null, or DNE, than file is not loaded
WriteErrrorLogHeader	Parameters: Ofstream ErrorLog: In - The output filestream into which the header will be inserted.